Skip to content

Conversation

@ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented Jun 23, 2025

Link issues

fixes #6281

Summary By Copilot

Regression?

  • Yes
  • No

Risk

  • High
  • Medium
  • Low

Verification

  • Manual (required)
  • Automated

Packaging changes reviewed?

  • Yes
  • No
  • N/A

☑️ Self Check before Merge

⚠️ Please check all items below before review. ⚠️

  • Doc is updated/provided or not needed
  • Demo is updated/provided or not needed
  • Merge the latest code from the main branch

Summary by Sourcery

Redesign the ITcpSocketFactory.GetOrCreate method to use a factory delegate for endpoint creation and propagate this change through the default implementation and tests, while removing the obsolete extension.

Enhancements:

  • Change GetOrCreate signature to accept a Func<string, IPEndPoint> for deferred endpoint generation
  • Update DefaultTcpSocketFactory to invoke the provided factory delegate when creating clients
  • Remove the deprecated ITcpSocketFactoryExtensions class

Tests:

  • Revise unit tests to call the new GetOrCreate overload with value factory functions instead of endpoint parameters

@bb-auto bb-auto bot added the enhancement New feature or request label Jun 23, 2025
@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Jun 23, 2025

Reviewer's Guide

This PR redesigns the GetOrCreate method to accept a factory function for endpoint creation, updates the default factory implementation and unit tests accordingly, and removes a deprecated extension file.

Class diagram for redesigned ITcpSocketFactory interface and DefaultTcpSocketFactory implementation

classDiagram
    class ITcpSocketFactory {
        +ITcpSocketClient GetOrCreate(string name, Func<string, IPEndPoint> valueFactory)
        +void Remove(string name)
        +void Dispose()
    }
    class DefaultTcpSocketFactory {
        +ITcpSocketClient GetOrCreate(string name, Func<string, IPEndPoint> valueFactory)
        +void Remove(string name)
        +void Dispose()
        -ConcurrentDictionary<string, ITcpSocketClient> _pool
        -IServiceProvider provider
    }
    ITcpSocketFactory <|.. DefaultTcpSocketFactory
    class ITcpSocketClient
    class DefaultTcpSocketClient
    ITcpSocketClient <|.. DefaultTcpSocketClient
    DefaultTcpSocketFactory --> ITcpSocketClient : manages
    DefaultTcpSocketFactory --> DefaultTcpSocketClient : creates
    class Func~string, IPEndPoint~
    class IPEndPoint
    DefaultTcpSocketFactory ..> Func~string, IPEndPoint~ : uses
    DefaultTcpSocketClient ..> IPEndPoint : uses
Loading

Class diagram for removed ITcpSocketFactoryExtensions

classDiagram
    class ITcpSocketFactoryExtensions {
        <<removed>>
    }
Loading

File-Level Changes

Change Details Files
Refactored GetOrCreate to accept a value factory function for endpoint creation
  • Changed signature in ITcpSocketFactory from endpoint parameter to Func<string, IPEndPoint>
  • Updated XML docs to describe valueFactory behavior
  • Modified DefaultTcpSocketFactory to invoke valueFactory for endpoint instantiation
src/BootstrapBlazor/Services/TcpSocket/ITcpSocketFactory.cs
src/BootstrapBlazor/Services/TcpSocket/DefaultTcpSocketFactory.cs
Updated unit tests to use new GetOrCreate signature
  • Replaced direct endpoint args with lambdas calling Utility.ConvertToIpEndPoint
  • Ensured equivalence assertions remain intact
test/UnitTest/Services/TcpSocketFactoryTest.cs
Removed obsolete extension for ITcpSocketFactory
  • Deleted the ITcpSocketFactoryExtensions.cs file
src/BootstrapBlazor/Extensions/ITcpSocketFactoryExtensions.cs

Assessment against linked issues

Issue Objective Addressed Explanation

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@bb-auto bb-auto bot added this to the 9.7.0 milestone Jun 23, 2025
Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @ArgoZhang - I've reviewed your changes - here's some feedback:

  • Consider renaming the valueFactory parameter to something like endPointFactory to more clearly convey that it produces an IPEndPoint.
  • Add null checks for both name and valueFactory in GetOrCreate to fail fast when either argument is null.
  • Since this replaces the old GetOrCreate(name, IPEndPoint) overload, consider providing a deprecated overload or migration guide to prevent breaking existing callers.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- Consider renaming the `valueFactory` parameter to something like `endPointFactory` to more clearly convey that it produces an `IPEndPoint`.
- Add null checks for both `name` and `valueFactory` in `GetOrCreate` to fail fast when either argument is null.
- Since this replaces the old `GetOrCreate(name, IPEndPoint)` overload, consider providing a deprecated overload or migration guide to prevent breaking existing callers.

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@codecov
Copy link

codecov bot commented Jun 23, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (7826f22) to head (070db4f).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #6282   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          713       712    -1     
  Lines        31400     31397    -3     
  Branches      4437      4437           
=========================================
- Hits         31400     31397    -3     
Flag Coverage Δ
BB 100.00% <100.00%> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@ArgoZhang ArgoZhang merged commit 0df17f5 into main Jun 23, 2025
6 checks passed
@ArgoZhang ArgoZhang deleted the feat-socket branch June 23, 2025 06:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

feat(ITcpSocketFactory): redesign GetOrCreate method

2 participants